home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / newuser1.zip / NEWUSER.DOC < prev    next >
Text File  |  1992-08-28  |  13KB  |  274 lines
  1.                                                                   Page  1
  2.  
  3.           ╒══════════════════════════════════════════════════════╕
  4.           │                      NewUser                         │
  5.           ├──────────────────────────────────────────────────────┤
  6.           │         A PCBoard NewUser AutoMessage Utility        │
  7.           ├──────────────────────────────────────────────────────┤
  8.           │     Version 1.0    08/27/92   Copyright (c) 1992     │
  9.           ╘══════════════════════════════════════════════════════╛
  10.  
  11.  
  12. WHAT IS NEWUSER ?
  13. -----------------
  14.  
  15. With the multitude of PCBoard utilities available, I was surprised
  16. that I had never seen a simple utility which would automatically
  17. (in your EVENT) send new users of the BBS a personalized message from
  18. the SYSOP welcoming them to the BBS. As I am sure a lot of sysops
  19. would possibly like this capability, and being that I am not aware
  20. of any existing similar program, I decided to sit down and write
  21. a small program which would leave welcome messages. A short while
  22. later NEWUSER was created.
  23.  
  24. NewUser is a nice little program which will read your ANSWERx file,
  25. extract your newusers and allow you to send them a personal message
  26. on the BBS welcoming them to the board, informing them of rules, etc.
  27.  
  28. NEWUSER is not quite a stand-alone program. It requires the use of
  29. a companion shareware program called TXT2MSG. TXT2MSG is written
  30. and copyrighted by Robert Vostreys and is widely available on most
  31. BBS's which have a sysop file section or directly from Robert on
  32. his BBS (The FTL BBS). NewUser reads your ANSWERx file, and based on
  33. the information you provide in the configuration file, generates
  34. a DOS batch file which invokes TXT2MSG with the appropriate parameters
  35. to insert new messages into your PCBoard Message Base.
  36.  
  37. CAPABILITIES and LIMITATIONS
  38. ----------------------------
  39. NEWUSER can process over 1200 new users at a time. It can be called as
  40. often as needed in a single nightly event and process as many different
  41. ANSWERx scripts as you need while generating only one calling batch file
  42. for TXT2MSG to use. If you have a user who answers a questionnaire more
  43. than one time, NEWUSER will only generate one message for that person.
  44.  
  45. DISTRIBUTION FILES
  46. -----------------
  47. Included in your ZIP file should at least be the following programs.
  48. If these files are not in the copy of the ZIP you have, then call
  49. Xignals PCBoard and download a complete copy.
  50.  
  51. NEWUSER.EXE      <-------- NewUser Executable Program
  52. NEWUSER.DOC      <-------- This Documentation
  53. NEWUSER.CFG      <-------- Sample Configuration File
  54. WELCOME.TXT      <-------- Sample Welcome Message
  55. SAMPLE.BAT       <-------- Sample "Event" Batch File
  56. FILE_ID.DIZ      <-------- PCBoard upload description file
  57. README.TXT       <-------- Information on Cost etc...
  58.  
  59.  
  60.  
  61.  
  62. OPERATION                                                         Page  2
  63. ---------
  64.  
  65. The General syntax for running NEWUSER is:
  66.  
  67. NEWUSER <config file>
  68.  
  69. ex: NEWUSER NEWUSER.CFG
  70.  
  71. <config file> would be the configuration file you create.
  72. NOTE: If you want to process multiple questionnaires, you will need
  73. to have a unique config file for each questionnaire and invoke
  74. NEWUSER once for each ANSWERx file.
  75.  
  76. If you do not specify a config file on the command line, NEWUSER
  77. will try to use the default config file "NEWUSER.CFG" in the same
  78. directory from which NEWUSER was called.
  79.  
  80. If you forget the syntax, then you can get a brief description of the
  81. command line syntax by typing:  NEWUSER /?
  82.                            or:  NEWUSER -?
  83.                            or:  NEWUSER Help.
  84. Anything other than the config file or the help requestor will cause the
  85. program to abort.
  86.  
  87. If NEWUSER cannot find the .CFG file or the ANSWERx file, it will abort
  88. and print a short message to a file called ERROR.RPT in the default
  89. directory. If the file ANSWERx is locked by another node on a network,
  90. NEWUSER will exit and write an error message to the ERROR.RPT file.
  91.  
  92. As stated before, NEWUSER will generate a batch file which will call
  93. the shareware program TXT2MSG. TXT2MSG is a neat little program in
  94. itself and offers some other interesting capabilities on it's own.
  95. For our purposes, all you will need to do with TXT2MSG is copy the file
  96. TXT2MSG to a directory in your dos path or to the directory from which
  97. you will run NEWUSER, or fully qualify the location of the TXT2MSG
  98. program in your configuration file. There is no requirement that you
  99. do anything else with TXT2MSG, other than it being accessible to NEWUSER.
  100.  
  101.  
  102.  
  103.  
  104. EVENT PROCESSING                                                  Page  3
  105. ----------------
  106.  
  107. A sample batch file (SAMPLE.BAT) is included with NEWUSER. It looks
  108. something like this:
  109.  
  110. D:                                    <------ (LINE 1 )
  111. CD\PCB\MAIN                           <------ (LINE 2 )
  112. TYPE ANSWER1 >> ANSWER1.HST           <------ (LINE 3 )
  113. IF EXIST MAIL.BAT DEL MAIL.BAT        <------ (LINE 4 )
  114. IF EXIST ANSWER1. NEWUSER NEWUSER.CFG <------ (LINE 5 )
  115. IF EXIST MAIL.BAT CALL MAIL.BAT       <------ (LINE 6 )
  116. IF NOT EXIST MAIL.BAT GOTO LATER      <------ (LINE 7 )
  117. DEL ANSWER1                           <------ (LINE 8 )
  118. :LATER                                <------ (LINE 9 )
  119. CD\PCB                                <------ (LINE 10)
  120. BOARD                                 <------ (LINE 11)
  121.  
  122. That's it! ....... If you have already got an EVENT.SYS file with
  123. nightly processing in it, then all you have to do is modify your
  124. existing EVENT.SYS file to include the above (modified of course to
  125. match your system.
  126.  
  127. LINE 01  - Places you on the proper drive (trivial, but safer)
  128. LINE 02  - Changes to the dir where your ANSWERx files are stored.
  129. LINE 03  - Appends your "DAILY" ANSWERx file to a retention history
  130.            copy. NOTE: You must use >> to append using the type
  131.            command. If you use > (a single > sign) you will overwrite
  132.            the existing ANSWER1.HST file.
  133. LINE 04  - Removes any lingering MAIL.BAT file from previous runs.
  134. LINE 05  - Checks to see if you have an ANSWERx file and if so executes
  135.            NEWUSER with a config file of NEWUSER.CFG
  136. LINE 06  - Checks to see if you have a successfully created MAIL.BAT
  137.            file and if so, CALLS the MAIL.BAT file.
  138.            NOTE: If you are using a DOS version prior to 3.3, the CALL
  139.                  statement probably will not work. You will have to
  140.                  replace CALL with something like COMMAND /C .
  141.                  Check your DOS manual for the correct syntax if needed.
  142. LINE 07  - If MAIL.BAT doesn't exist for some reason or another, it
  143.            skips the next line which deletes the ANSWERx file. This way
  144.            you can run again the next night after you figure out why
  145.            there was a problem the first time.
  146. LINE 08  - Deletes the ANSWERx file so that tomorrow you will have a new
  147.            ANSWER copy with only new callers in it. (Avoids duplicity).
  148. LINE 09  - This is just a label for line # 7.
  149. LINE 10  - Changes back to the default PCB directory (trivial, but safer)
  150. LINE 11  - Restarts PCBoard .......... Betch'ya knew that one huh!
  151.  
  152. Obviously, this is only an example, you can get more technical or simple
  153. as you see fit. I think that a sample batch file like this shows how the
  154. process works better than wordy documentation does .............
  155. The key thing to remember is that NEWUSER only creates an output batch
  156. file. That batch file is appended to if it already exist. How you decide
  157. to process, and in what order up to you. The above is only an example.
  158.  
  159.  
  160.  
  161. CONFIGURATION FILE                                                Page  4
  162. ------------------
  163.  
  164. D:\PCB\MAIN\ANSWER1                <------ (LINE 1 )
  165. D:\PCB\MAIN\MAIL.BAT               <------ (LINE 2 )
  166. D:\PCB\MAIN\MSGS                   <------ (LINE 3 )
  167. D:\PCB\MAIN\WELCOME.TXT            <------ (LINE 4 )
  168. WELCOME NEW USER                   <------ (LINE 5 )
  169. MILES LESTER                       <------ (LINE 6 )
  170. NO                                 <------ (LINE 7 )
  171.  
  172. The CONFIGURATION File is REQUIRED! NEWUSER will NOT work without it.
  173. The file must contain all seven lines with valid values on each line
  174. and they must be in the order presented above.
  175.  
  176. LINE 01  - Name and Location of your ANSWERx file
  177. LINE 02  - Name and Location of the MAIL batch file to be created
  178. LINE 03  - Name and Location of PCBoard Message Base which messages
  179.            are to be added. This can be any valid message base
  180.            from the main board to any conference you chose.
  181. LINE 04  - Name and Location of the Message text you wish to be
  182.            sent to the user. You can include PCBoard @ macros
  183.            imbedded in the message (such as @FIRST@) to personalize
  184.            the feel of the message. This is a straight text file.
  185. LINE 05  - This is the text you wish to be the SUBJECT: of the message.
  186.            This field is limited to 25 characters.
  187. LINE 06  - This represents who the message will be FROM:
  188.            You could put your name, "SYSOP", or "WELCOME WAGON" or
  189.            whomever you want the message to be from.
  190.            This field is limited to 25 characters.
  191. LINE 07  - This field is the indicator for whether or not the message
  192.            will be PRIVATE (receiver only) mail.
  193.            Valid Values:  YES or Y  (For PRIVATE R/O)
  194.                            NO or N  (For Public)
  195.  
  196. OUTPUT FILES
  197. ------------
  198.  
  199. MAIL.BAT  (Or whatever file you specified on line 2 of the .cfg file).
  200.  
  201. NEWUSER will normally only generate the MAIL.BAT file which you
  202. specified in the configuration program. The file MAIL.BAT is
  203. created if it doesn't already exist, and appended to if it already
  204. exists. The append feature is what allows you to create multiple config
  205. files and process each config file, but only creating one MAIL.BAT file.
  206. This would allow you to process the NEWUSER Script Questionnaire,
  207. perhaps a visiting Sysop's questionnaire, and maybe an Adult Application
  208. questionnaire all in the same event. You could send totally different
  209. messages in totally different conferences to each group of users.
  210.  
  211. The only other file NEWUSER will create is the file called ERROR.RPT.
  212. This file is only created if you have an error while trying to access
  213. one or more of the files.
  214.  
  215.  
  216. DISCLAIMER (you knew! this was coming ...)                        Page  5
  217. __________________________________________
  218.  
  219. MilesWare hereby disclaims all warranties relating to this product,
  220. whether express or implied, including without limitation any implied
  221. warranties of merchantability or fitness for a particular purpose.
  222. MilesWare cannot and will not be liable for any special, incidental,
  223. consequential, indirect or similar damages due to loss of data or
  224. any other reason, even if MilesWare or an authorized MilesWare
  225. agent has been advised of the possibility of such damages. In no
  226. event shall the liability for any damages ever exceed the price
  227. paid for the license to use software, regardless of the form
  228. and/or extent of the claim. The user of this program bears all risk
  229. as to the quality and performance of the software.
  230.  
  231. COPYRIGHT AND ACKNOWLEDGEMENTS
  232. ------------------------------
  233.  
  234.     NEWUSER is not public domain. It is copyrighted software.
  235.        Copyright (c) 1992 MilesWare,  All Rights Reserved.
  236.  
  237.        TXT2MSG is Copyright (c) 1988, 90, 91 Robert Vostreys
  238.  
  239. I would like to thank Robert for creating TXT2MSG. Great little tool
  240. to aid a sysop in lots of useful ways.
  241. I would also like to thank Richard Pope and Floyd Vest for assisting
  242. me with the more difficult programming routines. It's absolutely
  243. frightening how similar Amiga Basic is to QuickBasic. Thanks guys.
  244.  
  245. NEWUSER is written completely in Microsoft QuickBasic 4.5
  246.  
  247. SUPPORT AND UPDATES
  248. -------------------
  249.  
  250. The Latest copy of NEWUSER (and other PCBoard utils by MilesWare) can by
  251. always be found on:      XIGNALS PCBoard
  252.                          (205) 821-4664  14.4 USR HST/DUAL
  253.                          Miles Lester (Author and Sysop)
  254.                          Auburn, Alabama
  255.  
  256. TXT2MSG, if not available where you got NEWUSER from, can be downloaded
  257. from:                    FASTER-THAN-LIGHT BBS
  258.                          (404) 292-8761
  259.                          Robert Vostreys (Sysop)
  260.                          Atlanta, Ga.
  261.  
  262. If you have problems or suggestions or just want to say thanks for a
  263. simple but useful utility, then you can reach me via the following
  264. methods.
  265.  
  266. SALT AIR BBS             Home of PCBoard --- I call at least weekly
  267. ILink                    In the Ilink sysop's conference
  268. InterNet                 mlester@ducvax.auburn.edu
  269. BitNet                   mlester@auducvax.bitnet
  270. Xignals PCBoard          number is posted above etc..
  271. U.S. Postal Service      Miles Lester
  272.                          1001 E. Samford Ave.
  273.                          Auburn, AL 36830
  274.